From e62385395a3ac5f7c36ecefcd613f48cfa15d4ad Mon Sep 17 00:00:00 2001 From: Andinus Date: Sun, 10 Oct 2021 19:25:30 +0530 Subject: Add plotly, update README to add Development notes --- README | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) (limited to 'README') diff --git a/README b/README index 55c9024..bf1d1f3 100644 --- a/README +++ b/README @@ -10,26 +10,31 @@ Table of Contents ───────────────── +Installation Development License +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + Demo + Website +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - Website Source GitHub (mirror) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ -Development -═══════════ +Installation +════════════ The project is written in [Svelte]. ┌──── │ # 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. @@ -40,6 +45,22 @@ Development [Svelte] +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 ═══════ -- cgit 1.4.1-2-gfad0