Skip to content

Commit 024db47

Browse files
committed
Add docs and mockup
1 parent 04525ac commit 024db47

File tree

2 files changed

+65
-1
lines changed

2 files changed

+65
-1
lines changed

README.md

+65-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,66 @@
1-
# docs
1+
# Planner 2.0 docs
2+
23
Official documents and development recommendations
4+
5+
## Mockup
6+
7+
[![Precursor](https://precursorapp.com/document/Mockup-Planner2-17592204070496.svg?auth-token=)](https://precursorapp.com/document/Mockup-Planner2-17592204070496)
8+
9+
Get the `.pdf` version [here](./mockup.pdf).
10+
11+
## Development
12+
13+
### Requirements
14+
15+
* [Node.js 6](https://nodejs.org/en/)
16+
* [Python 3](https://www.python.org/)
17+
18+
### Dependencies
19+
20+
```sh
21+
pip install -U autopep8 flake8 pep8
22+
```
23+
24+
```sh
25+
npm install -g babel-eslint eslint eslint-plugin-flowtype eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react htmlhint jsonlint nodemon tern
26+
```
27+
28+
### IDE
29+
30+
The usage of Atom as the main IDE is recommended, along with these plugging:
31+
32+
```sh
33+
# Common
34+
autoclose-html
35+
highlight-line
36+
highlight-selected
37+
indent-guide-improved
38+
trailing-spaces
39+
sublime-style-column-selection
40+
editorconfig
41+
autocomplete-paths
42+
file-icons
43+
pigments
44+
atom-beautify
45+
linter
46+
47+
# Python
48+
autocomplete-python
49+
linter-flake8
50+
linter-pep8
51+
52+
# Javascript
53+
atom-ternjs
54+
linter-eslint
55+
linter-jsonlint
56+
linter-csslint
57+
language-babel
58+
turbo-javascript
59+
```
60+
61+
Install all with:
62+
63+
```sh
64+
apm install autoclose-html highlight-line highlight-selected indent-guide-improved trailing-spaces sublime-style-column-selection editorconfig autocomplete-paths file-icons pigments atom-beautify linter autocomplete-python linter-flake8 linter-pep8 atom-ternjs linter-eslint linter-jsonlint linter-csslint language-babel turbo-javascript
65+
66+
```

mockup.pdf

239 KB
Binary file not shown.

0 commit comments

Comments
 (0)