Skip to content
This repository was archived by the owner on Jun 13, 2024. It is now read-only.

Commit a6da09e

Browse files
authored
Update README.md
1 parent 0c1697c commit a6da09e

File tree

1 file changed

+25
-13
lines changed

1 file changed

+25
-13
lines changed

README.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,28 +23,37 @@ Inspiration behind Termicoder
2323

2424
### User installation
2525

26-
`pip install termicoder`
27-
use sudo -H if required. preferably use pip3 (python3)
26+
`pip3 install termicoder`
2827

29-
### Developer installation
28+
### Developer installationhttps://github.com/termicoder/codechef-oauth
3029

3130
- clone this repo
3231
- in the root folder of this repo run
33-
- `pip install --editable .`
32+
- `pip3 install --editable .`
3433

3534
notice the dot(.) in above command at the end
3635

37-
Note: it is better to use virtualenv and pip3 (python3)
36+
Note: it is better to use virtualenv
3837

39-
- to remove this package, in the root folder of the repo run
38+
- to remove this package, in the root folder of the repo, run:
4039
- `python setup.py develop --uninstall`
4140

4241
**Note: Termicoder is in its development stage and has only been tested on Ubuntu + python3. Support for other configurations is being worked on, if you are using some other platform and encounter errors, do create an [issue](https://github.com/diveshuttam/termicoder/issues) for them. For windows one can also try using [Bash on Ubuntu on Windows](https://msdn.microsoft.com/en-us/commandline/wsl/about) ; most features have been tested out there and work as expected.**
4342

44-
### Autocomplete for bash
43+
### Configuration
44+
45+
- After installing termicoder you have to initialize the configurations files. You can do this by
46+
- `termicoder config init`
47+
48+
- To edit configurations:
49+
- `termicoder config edit`
50+
51+
### Tab Autocompletion
52+
53+
- To setup tab autocompletion for termicoder commands
54+
- `termicoder config autocomplete --help`
55+
- the above currently supports autocompletions for `bash`, `fish`, `powershell`, `zsh`
4556

46-
To setup tab autocompletion for termicoder commands,
47-
see `termicoder config autocomplete --help`
4857

4958
## Current Support
5059

@@ -139,6 +148,11 @@ You can also contribute otherwise by
139148
This is a complete redesign and rewrite of _termicoder_ to support judges as plugins,
140149
As well as to support the new codechef API.
141150

151+
This distribution currently includes judge plugin `codechef` implemented using
152+
[codechef api](http://developers.codechef.com/) for [codechef api hackathon powered by Alibaba](https://www.codechef.com/CAH1801). We are working on support for other judges.
153+
The API authentication backend for authenticating with CodeChef is hosted at https://termicoder.diveshuttam.me
154+
whose source code can be found in [codechef-oauth](https://github.com/termicoder/codechef-oauth).
155+
142156
Unlike [previous implementation](https://github.com/termicoder/termicoder/tree/previous_alpha) this
143157
completely does away with `exec` and `eval` calls. And implements `Judges`,
144158
`Problems` and `Contests` as classes instead of modules.
@@ -155,11 +169,9 @@ termicoder would be available soon. By then you can look at the
155169
See setup.py for example of how to subscribe to entry point
156170
`termicoder.judge_plugins`.
157171

158-
This distribution currently includes judge plugin `codechef` implemented using
159-
[codechef api](http://developers.codechef.com/) for [codechef api hackathon powered by Alibaba](https://www.codechef.com/CAH1801)
160-
161172
There are also many completely new features implemented in this version including
162-
`termicoder repl`, `termicoder config`, `termicoder clip`, `termicoder config autocomplete`
173+
`termicoder repl`, `termicoder config`, `termicoder clip`, `termicoder config autocomplete`.
174+
Also the configurations are now completely YAML based with support for jinja like substitutions.
163175

164176
Though this implementation lacks support for colors as well as a few other
165177
features which were present in previous implementation.

0 commit comments

Comments
 (0)