Skip to content

Commit f7350c9

Browse files
authored
Update README.md
1 parent 508690c commit f7350c9

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,37 @@
11
# Compose
22

3-
⚠️ This project is a work in progress and is likely to be buggy and maybe abandon if it doesn't make sense.
3+
⚠️ This project is still in development. Please report bug but don't expect everything to work very smoothly.
44

5-
A module with scripts and jupyter/colab notebooks for creating 2d vector graphics using machine learning.
5+
A python module to streamline working with 2D and 3D vector graphics in machine learning projects.
66

7-
## Notebooks
8-
9-
Image to SVG Notebook
7+
Much of the philosophy of this module is based on [Processing](https://processing.org/) and [p5.js](https://p5js.org/). In other words it favors more accessible syntax over complete efficiency.
108

11-
`coming soon`
9+
## Notebooks
1210

13-
Image to Plotter SVG
11+
Single Image Notebook: [./notebooks/compose_test_01_py.ipynb](./notebooks/compose_test_01_py.ipynb)
1412

15-
`coming soon`
13+
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/duskvirkus/compose/blob/main/notebooks/compose_test_01_py.ipynb)
1614

17-
Create Animation
15+
Video Notebook (very hacky): [./notebooks/compose_test_04_py.ipynb](./notebooks/compose_test_04_py.ipynb)
1816

19-
`coming soon`
17+
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/duskvirkus/compose/blob/main/notebooks/compose_test_04_py.ipynb)
2018

2119
## Installing Locally
2220

23-
For a more streamlined process use jupyter lab and vanilla jupyter notebooks.
24-
25-
### Python Config
21+
### Platform
2622

2723
Recommended python version is 3.7. Ubuntu based Linux is currently the only supported platform. If you run into issues on other platforms feel free to file an issue but it will be low priority.
2824

29-
*If you use Anaconda*
25+
### Anaconda Setup
26+
3027
```bash
3128
conda create -n compose python=3.7
3229
conda activate compose
3330
conda install -c conda-forge jupyterlab
3431
conda install -c anaconda ipykernel
3532
python -m ipykernel install --user --name=compose
3633
```
34+
3735
### Dependancies
3836

3937
```bash
@@ -48,6 +46,10 @@ cd ..
4846
python setup.py install
4947
```
5048

49+
## Documentation
50+
51+
Currently documentation could use some work and can only be built locally. See CONTRIBUTING.md for some instructions.
52+
5153
## Thanks
5254

5355
This project would not be possible without the work of the creators of diffvg Tzu-Mao Li, Michal Lukáč, Michaël Gharbi, and Jonathan Ragan-Kelley.

0 commit comments

Comments
 (0)