Merge pull request #40 from mbrukman/fix-readme

Fix spelling and formatting in README [skip ci]
This commit is contained in:
Haris Iqbal
2019-07-30 11:20:25 +02:00
committed by GitHub
+22 -13
View File
@@ -26,26 +26,32 @@ Base on this [website](https://gist.github.com/rain1024/98dd5e2c6c8c28f9ea9d), p
## 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(),
@@ -59,12 +65,15 @@ Base on this [website](https://gist.github.com/rain1024/98dd5e2c6c8c28f9ea9d), p
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