Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs update #287

Merged
merged 9 commits into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Currently Windows and Mac are supported:

# About

Carpe is a desktop "wallet" that connects to the 0L network and lets you create accounts, do some account management. It also is a light "miner" allowing you to mine coins! To learn more about 0L itself follow the link: [0L introduction](https://github.com/OLSF/libra#readme).
Carpe is a desktop "wallet" that connects to the 0L network and lets you create accounts, do some account management. To learn more about 0L itself, you can check out the official website of the project : [0L Network website](https://0l.network/).

# Creating Accounts

Expand Down
2 changes: 1 addition & 1 deletion docs/canary-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Canary version allows you to have both installations side-by-side without interf

Canary versions will receive Over-The-Air updates just like the production version.

[Download Carpe Canary Here](https://github.com/0LNetworkCommunity/carpe/releases/tag/v1.0.0-16-canary)
[Download Carpe Canary Here](https://github.com/0LNetworkCommunity/carpe/releases/tag/v1.0.1-3-canary)
6 changes: 3 additions & 3 deletions docs/devs/get-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Developing and Building Carpe with Tauri and Svelte

Carpe leverages the power of [Tauri](https://tauri.studio) for building secure, lightweight desktop applications and [Svelte](https://svelte.dev) for creating efficient, reactive web interfaces. The template for Carpe can be found at: https://github.com/jbarszczewski/tauri-svelte-template.
Carpe leverages the power of [Tauri](https://tauri.app/) for building secure, lightweight desktop applications and [Svelte](https://svelte.dev) for creating efficient, reactive web interfaces. The template for Carpe can be found at: https://github.com/jbarszczewski/tauri-svelte-template.

## Get Started

Expand All @@ -16,7 +16,7 @@ Ensure you have the following prerequisites installed:

Additionally, you'll need to set up your environment for Tauri development:

- Follow the Tauri setup guide: [Setting up your environment](https://tauri.studio/en/docs/getting-started/intro#setting-up-your-environment).
- Follow the Tauri setup guide: [Setting up your environment](https://tauri.app/v1/guides/).
- For Windows users, a specific guide is available: [Windows development environment setup](./windows-dev-setup.md).

### Installation Steps
Expand Down Expand Up @@ -55,6 +55,6 @@ This generates an optimized version of your application, including standalone ex

## Additional Resources

- [Tauri Studio](https://tauri.studio): Official Tauri project website with comprehensive documentation.
- [Tauri Studio](https://tauri.app/): Official Tauri project website with comprehensive documentation.
- [Svelte](https://svelte.dev): Home of the Svelte framework, with guides, tutorials, and API documentation.
- [Sveltestrap](https://sveltestrap.js.org): Bootstrap 4 components for Svelte, facilitating quick and responsive UI development.
2 changes: 1 addition & 1 deletion docs/devs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ Before creating a new TAG, please confirm that Cargo.toml file is pointing to th
If the app icon design will be changed, the high resolution file needs to be in `./app-icon.png`.
Then simply run `yarn tauri icon`, and all the icon formats will be created.

https://tauri.studio/docs/guides/icons/
[https://tauri.studio/docs/guides/icons/](https://tauri.app/v1/guides/features/icons/#__docusaurus_skipToContent_fallback)
2 changes: 1 addition & 1 deletion docs/devs/windows-dev-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ The MS compiler toolchain requires various environment variables set correctly.
Carpe can now be cloned from GitHub and built, in the shell opened in step 7, with the same commands as used for the Linux and MacOS builds:

```
git clone [[email protected]:OLSF/carpe.git](https://github.com/OLSF/carpe.git)
git clone https://github.com/0LNetworkCommunity/carpe.git
cd carpe
cd cd src-tauri
cargo build
Expand Down
2 changes: 1 addition & 1 deletion docs/start-carpe-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
You can find the installable Mac package in the releases folder:

macOS version 10.15 or higher
https://github.com/OLSF/carpe/releases/download/v0.3.0/carpe-macos-10.15.dmg
[https://github.com/OLSF/carpe/releases/download/v0.3.0/carpe-macos-10.15.dmg](https://github.com/0LNetworkCommunity/carpe/releases/download/v1.0.7/carpe_1.0.7_x64.dmg)

## Allow App Permissions

Expand Down
2 changes: 1 addition & 1 deletion docs/start-carpe-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

You can find the Windows 10 installer in the releases folder:

https://github.com/OLSF/carpe/releases/download/v0.3.0/carpe_0.3.0_x64.msi
[https://github.com/OLSF/carpe/releases/download/v0.3.0/carpe_0.3.0_x64.msi](https://github.com/0LNetworkCommunity/carpe/releases/download/v1.0.7/carpe_1.0.7_x64_en-US.msi)

# Important:

Expand Down
10 changes: 2 additions & 8 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,13 @@ On MacOS you will be prompted for your OS login password (on Windows and Ubuntu

![screen01](./img/keyring.png)

## Get a friend to onboard
## Get onboard

Until you can use the newly created account, you need some 0L user who "onboards" you. Please send the displayed "authkey" to this person.

After the onboarding transaction has been done, the wallet will show some BALANCE for your account and no longer the text "Account not on chain".

If you don't yet have a friend on 0L, come to the [Discord Server](https://discord.gg/AzCp63pggW) and make a new friend that can send your onboarding transaction.

## Mining

After your account has been onboarded, new menus appear on top of the screen. Switch to "MINER" to earn coins.

To start mining, just click on the red toggle button, so it turns into green color.
If you don't yet have a friend on 0L, come to the [Discord Server](https://discord.gg/AzCp63pggW) and send your 0L public adress in the onboarding channel.

## DANGER

Expand Down
Loading