Skip to content

Commit

Permalink
chore: readme
Browse files Browse the repository at this point in the history
Signed-off-by: Innei <[email protected]>
  • Loading branch information
Innei committed Sep 6, 2024
1 parent eac1965 commit b8d1636
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 2 deletions.
47 changes: 46 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,53 @@ Roadmap: https://github.com/orgs/RSSNext/projects/1/views/1

[![Discord](https://img.shields.io/discord/1243823539426033696?logo=discord&label=Discord&style=flat-square&color=5865F2)](https://discord.gg/xHCVQZ6wmZ) [![](https://img.shields.io/badge/any_text-Follow-blue?color=2CA5E0&label=_&logo=x&cacheSeconds=3600&style=flat-square)](https://x.com/intent/follow?screen_name=follow_app_)

## Release

Currently, Follow is still in the early developer preview stage (alpha) and is only available to a limited number of users through an invitation system.

If you have access, you are welcome to use the following methods to download and install it:

- You can get the installation packages for each platform from the [Release page](https://github.com/RSSNext/Follow/releases).
- If you are using Arch linux, you can install it using the community-contributed aur method:
- https://aur.archlinux.org/packages/follow-appimage by [timochan](https://github.com/ttimochan)
- https://aur.archlinux.org/packages/follow-bin by [@OnlyXuanwo](https://x.com/OnlyXuanwo)

## Contributing

If you are eligible to use Follow, you are welcome to join the open source community to build together.

Before you start, you need to install pnpm and then use it to install dependencies:

```sh
pnpm install
```

### Develop in the browser

```sh
pnpm run dev:web
```

Then the browser opens `https://app.follow.is/__debug_proxy`,you can access the online API environment to development and debugging.

### Develop in the electron

You need to fill in the required environment variables first.

```sh
cp .env.example .env
```

Then run:

```sh
pnpm run dev
```

Since it is not very convenient to develop in Electron, the first way to develop and contribute is recommended at this stage.

## License

Follow Desktop is licensed under the GNU General Public License version 3 with the addition of the following special exception:
Follow is licensed under the GNU General Public License version 3 with the addition of the following special exception:

All content in the `icons/mgc` directory is copyrighted by https://mgc.mingcute.com/ and cannot be redistributed.
2 changes: 1 addition & 1 deletion src/renderer/src/modules/app/EnvironmentIndicator.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {
export const EnvironmentIndicator = () => (
<Tooltip>
<TooltipTrigger asChild>
<div className="fixed bottom-0 right-0 rounded-tl bg-accent px-1 py-0.5 text-xs text-white">
<div className="fixed bottom-0 right-0 z-[99999] rounded-tl bg-accent px-1 py-0.5 text-xs text-white">
{import.meta.env.MODE}
</div>
</TooltipTrigger>
Expand Down

0 comments on commit b8d1636

Please sign in to comment.