Skip to content

Commit eec2308

Browse files
committed
added new readme
1 parent a9d850d commit eec2308

File tree

1 file changed

+62
-18
lines changed

1 file changed

+62
-18
lines changed

README.md

Lines changed: 62 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,79 @@
1-
# simple-browser
21

3-
An Electron application with Svelte
2+
# Rikser
43

5-
## Recommended IDE Setup
4+
Rikser is an electron based browser made to help students with their homework. It is primarily designed for Finnish market (note MAOL reference book), but can be used by anyone with little bit of tweaking.
65

7-
- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode)
86

9-
## Project Setup
7+
## Features
108

11-
### Install
9+
- Multiple tabs
10+
- Privacy first design
11+
- Reference book integration
12+
- Constant check and replacement across websites
13+
- LaTeX to Ascii Parser
14+
-
15+
16+
17+
## FAQ
18+
19+
#### What is this based on ?
20+
21+
Rikser is based on Chromium trough electron. It uses svelte as the main frontend library.
22+
23+
24+
#### Is Rikser being updated ?
25+
26+
Rikser will most probably not be updated regularly and the updates will mainly reflect the Finnish educational landscape needs.
27+
28+
#### Does Rikser use 3rd party such as google trackers ?
29+
30+
No Rikser is designed as privacy #1 browser and thus blocks most of these 3rd party trackers, it does not come installed with any analytics or tracking settings and is made to be used mainly for light research and homework.
31+
32+
33+
34+
35+
## Installation
36+
37+
You can install Rikser for Mac and Windows by going to this projects [releases](https://github.com/Swifterhtmler/Rikser/releases)
38+
39+
Or alternatively build from source by
1240

1341
```bash
14-
$ npm install
42+
git clone https://github.com/Swifterhtmler/Rikser.git
43+
cd Rikser
44+
npm install
1545
```
46+
47+
and then...
48+
## Deployment
1649

17-
### Development
50+
To deploy run
1851

1952
```bash
20-
$ npm run dev
53+
npm run build
2154
```
2255

23-
### Build
56+
or by choosing your system
2457

2558
```bash
26-
# For windows
27-
$ npm run build:win
59+
npm run build:[win; mac; linux]
60+
```
61+
62+
63+
64+
65+
## Optimizations
66+
67+
To optimitize the browser for your needs you can change the url of the reference book in the App.svelte by changing the CreateMAOLTab() function .createTab methods location.
68+
69+
## Tech Stack
70+
71+
**Client:** Svelte, Ts, Js, Css, HTML, Electron, Electron-builder
72+
73+
74+
75+
76+
## 🔗 Links
77+
[![portfolio](https://img.shields.io/badge/my_portfolio-000?style=for-the-badge&logo=ko-fi&logoColor=white)](https://swifterhtmler.github.io/Portfolio//)
2878

29-
# For macOS
30-
$ npm run build:mac
3179

32-
# For Linux
33-
$ npm run build:linux
34-
```
35-
# Rikser-v30000

0 commit comments

Comments
 (0)