diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/README.org b/README.org index b813455..3e25781 100644 --- a/README.org +++ b/README.org @@ -3,24 +3,38 @@ #+export_file_name: index #+setupfile: ~/.emacs.d/org-templates/projects.org -| Website | https://andinus.nand.sh/dorado | +| Demo | https://andinus.unfla.me/dorado | +| Website | https://andinus.unfla.me/projects/dorado | + | Source | https://git.unfla.me/dorado | | GitHub (mirror) | https://github.com/andinus/dorado | -* Development +* Installation The project is written in [[https://svelte.dev][Svelte]]. #+begin_src sh # Clone the project. -git clone https://git.tilde.institute/andinus/cg-algorithms -cd cg-algorithms +git clone https://git.tilde.institute/andinus/dorado +cd dorado npm install # Get dependencies. npm run dev # Build for development. npm run build # Build for deployment. #+end_src +* Development + +- ~src/App.svelte~: Main application. +- ~src/Home.svelte~: Home page. +- ~src/Navbar.svelte~: Navbar (links to all algorithms). +- ~src/algorithms~: Algorithms directory. + +** Adding a new Algorithm + +To add a new algorithm, create a file in ~src/algorithms~ and add the +entry to ~src/Navbar.svelte~. + * License #+begin_src |