From f5134c4503bcd1a046b97a82dc4f9401ccaf2541 Mon Sep 17 00:00:00 2001 From: pBouillon Date: Sun, 29 Jan 2023 15:01:37 +0100 Subject: [PATCH] Update the readme --- README.md | 98 +++++++++++++++++++++++++++---------------------------- 1 file changed, 49 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 03ff5c7..df1a001 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,49 @@ -

- Locutionis -

- -

- Small, online reference of figures of speech -

- -
- Locutionis homepage screenshot -
- -
- -[Locutionis](https://locutionis.vercel.app/) is a simple website on which french speakers can learn more about some figures of speech, their usages and where to find more about it. - -## Contributing - -Pull requests are welcome either to add more content or to improve the actual code quality. - -For major changes, please [open an issue](https://github.com/pBouillon/locutionis/issues/new) first to discuss what you would like to change. - -## Development - -### Requirements - -- [Node.js](https://nodejs.org/en/) -- [Git](https://git-scm.com/) - -#### Setup - -```bash -git clone https://github.com/pbouillon/locutionis.git -npm install -npm run dev -``` - -You can now navigate to [localhost:3000](http://localhost:3000/) and start coding in your favorite editor. - -## Architecture - -- **Hosting** - [Vercel](https://vercel.com/) -- **Styling** - - [Tailwind CSS](https://tailwindcss.com/) - - [Bootstrap Icons](https://icons.getbootstrap.com/) -- **Framework** - [Svelte](svelte.dev/) with [SvelteKit](https://kit.svelte.dev/) using [TypeScript](https://www.typescriptlang.org/) +

+ Locutionis +

+ +

+ Small, online reference of figures of speech +

+ +
+ Locutionis homepage screenshot +
+ +
+ +[Locutionis](https://locutionis.vercel.app/) is a simple website on which french speakers can learn more about some figures of speech, their usages and where to find more about it. + +## Contributing + +Pull requests are welcome either to add more content or to improve the actual code quality. + +For major changes, please [open an issue](https://github.com/pBouillon/locutionis/issues/new) first to discuss what you would like to change. + +## Development + +### Requirements + +- [Node.js](https://nodejs.org/en/) +- [Git](https://git-scm.com/) + +#### Setup + +```bash +git clone https://github.com/pbouillon/locutionis.git +npm install +npm run start +``` + +You can now navigate to [localhost:4200](http://localhost:4200/) and start coding in your favorite editor. + +## Architecture + +- **Hosting** - [Vercel](https://vercel.com/) +- **Styling** + - [Tailwind CSS](https://tailwindcss.com/) + - [Bootstrap Icons](https://icons.getbootstrap.com/) +- **Framework** - [Angular](https://angular.io/) (15.1.0)