Skip to content
This repository has been archived by the owner on Jun 2, 2023. It is now read-only.

Latest commit

 

History

History
117 lines (84 loc) · 4.63 KB

README.md

File metadata and controls

117 lines (84 loc) · 4.63 KB

/* eslint-disable vue/comment-directive */

AuroraOSS Website

GitHub GitHub code size in bytes GitHub last commit Website Project Status: Active – The project has reached a stable, usable state and is being actively developed. Actively Maintained

About

This is the main repository for the website hosted at auroraoss.com.

Contributing

Before doing a PR or commit, read the following documents to make sure your PR or commit is valid:

Translations

The way translated pages work here is (will be) by using submodules in git. This allows a repository to exist within a repository, meaning we can have many content repositories in different languages without having to edit most of the main repo itself. Please read this very well explained git gist on Git Submodules.

Every translation repo is assigned to a team, consisting of members who maintain the repo and check the content regularly. All changes must correspond with this parent repo.

  • German:
  • French:
  • Russian:
  • Chinese:
  • Spanish:
  • Italian:
  • Portuguese:

Development

Starting development server:

# Using npm 
npm run dev
# Using vuepress
vuepress dev src

Building static files:

# Using npm 
npm run build
# Using vuepress
vuepress build src
View license

MIT License

Copyright (c) 2021-present Austin Hornhead a.k.a austinhornhead_12/marchingon12

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Browser compatibility

Chrome/Chromium-based Browsers & Firefox Desktop

You should have no problem with theming or CSS breaking.

Firefox Mobile (Fenix)

You may experience JS breaking or random reloads while scrolling through the page.

The official Firefox has tons of fixes pending and many things still don't work with the mobile version. If you wish to remain using Firefox Mobile, use Mull by DivestOS, which you can download from their F-Droid repository:

Their fork has most of the fixes that make it stable and to use. Check out their source code here.

With Mull you won't experience any problems.

Credits

Kudos to the tachiyomiorg/website team for their help. Huge thanks to @robsonsobral for helping our with theming!