Devojo/README.md

68 lines
2 KiB
Markdown
Raw Normal View History

2024-12-05 03:50:41 +00:00
<br />
2024-12-05 03:02:13 +00:00
2024-12-05 03:50:41 +00:00
<div align="center">
2024-12-05 03:02:13 +00:00
2024-12-05 03:50:41 +00:00
<img src="logo" alt="New logo goes here" height="64"/>
2024-12-05 03:02:13 +00:00
2024-12-05 03:50:41 +00:00
</div>
2024-12-05 03:02:13 +00:00
2024-12-05 03:50:41 +00:00
<br/>
<div align="center">
A Desktop-Like Experience
<br />
[![Please don't upload to GitHub](https://md.sudovanilla.org/images/badges/nogithub/compact.png)](https://nogithub.codeberg.page)
</div>
2024-12-05 03:02:13 +00:00
# New name here soon :^)
NEW_NAME_HERE delivers a desktop-like experience for Penpot users with the additional of integrating tabs to conveniently traverse back and forth between projects. Offline support is available through the select your own instance option in settings, as well as the theme settings that may be applied to either the entire desktop app or simply the Penpot dashboard.
## Building
### Requirements
- [NodeJS](https://nodejs.org/) v23
- [Yarn](https://yarnpkg.com/) Classic (v1)
- [Python](https://www.python.org/) v3.13
- Supported OS:
- macOS
- Linux
### Install Packages
Before building anything, packages need to be installed first with Yarn:
```bash
yarn install
```
> Yarn is setup to use SudoVanilla's registry via the `.yarnrc` file. Please use SudoVanilla's registry if you use a different package manager.
### Run Build
Once packages are installed, with no issues, you can run the build command:
```bash
yarn run build
2024-12-05 03:50:41 +00:00
```
## License
```
Copyright (C) 2023 - 2025 MinPluto
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see https://www.gnu.org/licenses/.
```
___
> Forking Penpot Desktop to GitHub will not be tolerated by SudoVanilla