Fix spelling and formatting in README [skip ci]

* Add link to `examples` directory
* Convert text to complete sentences for readability
* Separate bash and Python code for better understanding
* Add Python syntax highlighting
* Add explicit instructions to help users get started easier
This commit is contained in:
Misha Brukman
2019-03-28 16:40:01 -04:00
parent ccb9a4791a
commit 431321dc43
+22 -13
View File
@@ -5,26 +5,32 @@ Latex code for drawing neural networks for reports and presentation. Have a look
## TODO
- [X] Python interfaz
- [X] Python interface
- [ ] Add easy legend functionality
- [ ] Add more layer shapes like TruncatedPyramid, 2DSheet etc
- [ ] Add examples for RNN and likes.
## Latex Usage
see examples
## Latex usage
## PyUsage
See [`examples`](examples) directory for usage.
mkdir my_project
cd my_project
## Python usage
First, create a new directory and a new Python file:
$ mkdir my_project
$ cd my_project
vim my_arch.py
import sys
sys.path.append('../')
from pycore.tikzeng import *
Add the following code to your new file:
# defined your arch
arch = [
```python
import sys
sys.path.append('../')
from pycore.tikzeng import *
# defined your arch
arch = [
to_head( '..' ),
to_cor(),
to_begin(),
@@ -38,12 +44,15 @@ Latex code for drawing neural networks for reports and presentation. Have a look
to_end()
]
def main():
def main():
namefile = str(sys.argv[0]).split('.')[0]
to_generate(arch, namefile + '.tex' )
if __name__ == '__main__':
if __name__ == '__main__':
main()
```
Now, run the program as follows:
bash ../tikzmake.sh my_arch