Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
slycelote committed Mar 22, 2017
1 parent fd4e553 commit d752a58
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 32 deletions.
4 changes: 2 additions & 2 deletions doc/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-->
## Supported online judges

| Online judge | Sample Problem URL | Sample Contest URL | CHelper Chrome plugin / ffcaide Firefox add-on |
| Online judge | Sample Problem URL | Sample Contest URL | CHelper Chrome plugin / CaideFox Firefox add-on |
| :----------: | :----------------: | :----------------: | :-------------------: |
| CodeChef | http://www.codechef.com/MAY15/problems/SETDIFF | http://www.codechef.com/COOK54 | + |
| Codeforces | http://codeforces.com/contest/1/problem/A, http://codeforces.com/gym/100681/problem/B | http://codeforces.com/contest/1 | + |
Expand All @@ -19,7 +19,7 @@

| Programming language | Command line support | IDE support | Smart testing | Library code inlining | Unused code removal |
| :------------------: | :------------------: | :--------------------: | :-----------: | :-------------------: | :-----------------: |
| C++ | + | VS, Codelite (partial) | + | + | + |
| C++ | + | VS; Codelite (partial) | + | + | + |
| C# | + | VS | + | - | - |


56 changes: 28 additions & 28 deletions libcaide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ caide is a command line application which is the core of caide software suite.
Simply unpack caide executable to your hard drive. Optionally, put it into a
directory in your PATH for easier access.

On Linux you will need to ensure certain libraries are installed, in
particular libstdc++6, zlib1g, libgmp10.

# Quick start
1. Run `caide init` in an empty directory to initialize caide project.
Expand Down Expand Up @@ -190,8 +188,7 @@ code:
and your compiler can parse it. In particular, avoid using compiler specific
functions.

You can [setup](#cpp) caide to use your system headers instead. VsCaide
will do this automatically.
You can [setup](#cpp) caide to use your system headers instead.

2. You can think of inliner as roughly the following algorithm:

Expand All @@ -201,13 +198,35 @@ will do this automatically.
* Remove unused code.

This should give you an idea of what kind of code you should avoid:
identically named classes/variables, `#define`s with different meaning in
different files etc.
identically named classes/global variables, `#define`s with different
meaning in different files etc.

3. Sometimes the inliner will erroneously remove a used declaration (a
function or a variable). You should report it, but for an immediate fix,
mark the declaration with `/// caide keep` or `/** caide keep */` comment
(note the triple slash and the double star).
function or a variable). You should [report it](#bugs), but for an
immediate fix, mark the declaration with `// caide keep` or `/* caide keep
*/` comment.


# Command reference

Run `caide -h` for the list of commands. Commands marked with (Internal) are
'plumbing layer' not meant for the end user but for use in scripts (such as
[builders](#builder)), IDEs etc.


<a name="bugs"/>
# Troubleshooting

You can report issues on [github](https://github.com/slycelote/caide/issues)
or in [Codeforces thread](http://codeforces.com/blog/entry/18838). Try to
include as much information as possible, such as:

* Your operating system (in Linux, output of `uname -a`).
* Your caide.ini file.
* If the problem is related to C++ code inliner, add a `-v` option to
`clang_options` list in caide.ini file. This will produce more diagnostics
output.


# Description of files in caide folder

Expand Down Expand Up @@ -251,22 +270,3 @@ it here.
* `.caideproblem` directory contains internal caide files. Don't modify them
unless you know what you're doing.


# Command reference

Run `caide -h` for the list of commands. Commands marked with (Internal) are
'plumbing layer' not meant for the end user but for use in scripts (such as
[builders](#builder)), IDEs etc.

# Troubleshooting

You can report issues on [github](https://github.com/slycelote/caide/issues)
or in [Codeforces thread](http://codeforces.com/blog/entry/18838). Try to
include as much information as possible, such as:

* Your operating system (in Linux, output of `uname -a`).
* Your caide.ini file.
* If the problem is related to C++ code inliner, add a `-v` option to
`clang_options` list in caide.ini file. This will produce more diagnostics
output.

1 change: 1 addition & 0 deletions libcaide/msys-env.bat
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ rem Replace the paths according to your system's configuration.
set HPPATH=c:\bin\HaskellPlatform\7.10.3
set PATH=c:\python27;C:\bin\msys-w64\bin\;c:\bin\mingw-w64\mingw32\bin;%HPPATH%\bin;%HPPATH%\lib\extralibs\bin;C:\bin\CMake\bin;%PATH%
set CSC=c:\Windows\Microsoft.NET\Framework\v4.0.30319\csc.exe
set PHANTOMJS=c:\bin\phantomjs.exe
2 changes: 1 addition & 1 deletion libcaide/msys-env.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
HPPATH=/c/bin/HaskellPlatform/7.10.3
export PATH="/c/python27:/c/bin/msys-w64/bin:/c/bin/mingw-w64/mingw32/bin:$HPPATH/bin:$HPPATH/lib/extralibs/bin:/c/bin/CMake/bin:$PATH"
export CSC=/c/Windows/Microsoft.NET/Framework/v4.0.30319/csc.exe

export PHANTOMJS=/c/bin/phantomjs.exe
2 changes: 1 addition & 1 deletion tccaide/tccaide.iml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="JAVA_MODULE" version="4">
<component name="NewModuleRootManager" inherit-compiler-output="true">
<component name="NewModuleRootManager" LANGUAGE_LEVEL="JDK_1_7" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$">
<sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
Expand Down

0 comments on commit d752a58

Please sign in to comment.