mirrors/Firefox-UI-Fix
1
Fork 0
mirror of https://github.com/black7375/Firefox-UI-Fix.git synced 2025-12-05 18:20:44 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Doc: Developer - Update to the latest information

Browse source
This commit is contained in:
alstjr7375 2022-12-20 04:59:55 +09:00
parent 40ecb8efa7
commit 04a1024b6a
3 changed files with 12 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/Project_Structure.md
View file

@ -18,7 +18,7 @@ The overall structure of this project.
root root
|- __tests__/: Mixin spec test |- __tests__/: Mixin spec test
|- icons/: Icons, illustrations |- icons/: Icons, illustrations
|- css/: Build result of SCSS Files |- css/: Build result of SCSS Files (Don't modify directly!!)
|- docs/: Development Documents |- docs/: Development Documents
|- src/: Source files |- src/: Source files
|- src/leptonChrome.scss: Entry of SCSS for Browser UI |- src/leptonChrome.scss: Entry of SCSS for Browser UI
@ -32,11 +32,13 @@ root
|- package.json: Build setup, package dependency |- package.json: Build setup, package dependency
|- LEPTON: Meta infos (branch, version) |- LEPTON: Meta infos (branch, version)
|- user.js: about:config settings |- user.js: about:config settings
|- userChrome.css: Entry of css for Browser UI (Don't modify directly!!) |- userChrome.css: Entry of css for Browser UI (Modify only when customizing!!)
|- userContent.css: Entry of css for Web pages (Don't modify directly!!) |- userContent.css: Entry of css for Web pages (Modify only when customizing!!)
|- yarn.lock: Auto generated dependency (Don't modify directly!!) |- yarn.lock: Auto generated dependency (Don't modify directly!!)
``` ```
If you first come, it's a good idea to see the [`/src/leptonChrome.scss`](/src/leptonChrome.scss) and [`leptonContent.scss`](/src/leptonContent.scss) files to understand the flow.
## Icon files ## Icon files
Most of them are made in SVG. Most of them are made in SVG.

1
docs/README.md
View file

@ -103,6 +103,7 @@ Start Guide:
CSS, SASS Documents: CSS, SASS Documents:
- [MDN: CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) - [MDN: CSS](https://developer.mozilla.org/en-US/docs/Web/CSS)
- [MDN: Introducing the CSS Cascade](https://developer.mozilla.org/en-US/docs/Web/CSS/Cascade) - [MDN: Introducing the CSS Cascade](https://developer.mozilla.org/en-US/docs/Web/CSS/Cascade)
- [MDN: Introducing the CSS Specific](https://developer.mozilla.org/en-US/docs/Web/CSS/Specificity)
- [SASS(SCSS)](https://sass-lang.com/documentation) - [SASS(SCSS)](https://sass-lang.com/documentation)
- [SASS Live Compile](https://www.sassmeister.com/) - [SASS Live Compile](https://www.sassmeister.com/)

10
docs/Rules.md
View file

@ -45,13 +45,15 @@ It comes from [#109](https://github.com/black7375/Firefox-UI-Fix/issues/109#issu
Stable: Only bugfix, Documentation. Stable: Only bugfix, Documentation.
- `master`: Common bugfix, documentation. - `master`: Common bugfix, documentation.
- `photon-style`: Bugfix, documentation specified in `photon-style`. - `photon-style`: Config, documentation specified in `photon-style`.
- `proton-style`: Bugfix, documentation specified in `proton-style`. - `proton-style`: Config, documentation specified in `proton-style`.
Development: New Features. Development: New Features.
- `dev`: Common new features. - `dev`: Common new features.
- `photon-style-dev`: New features specified in `photon-style`. - `photon-style-dev`: New config specified in `photon-style`.
- `proton-style-dev`: New features specified in `proton-style`. - `proton-style-dev`: New config specified in `proton-style`.
After version [`v5.0.0`](https://github.com/black7375/Firefox-UI-Fix/releases/tag/v5.0.0), the distribution is just a [setting difference](https://github.com/black7375/Firefox-UI-Fix/wiki/Options#distribution-settings).
## Edit ## Edit
### Modify only source file ### Modify only source file