You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-29Lines changed: 36 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,30 +4,29 @@ What is Gridcoin?
4
4
Gridcoin is a POS-based cryptocurrency that rewards users for participating on the [BOINC](https://boinc.berkeley.edu/) network.
5
5
Gridcoin uses peer-to-peer technology to operate with no central authority - managing transactions, issuing money and contributing to scientific research are carried out collectively by the network.
6
6
7
-
For Gridcoin binaries, as well as more information, see https://gridcoin.us/.
7
+
For Gridcoin binaries, see the [GitHub releases page](https://github.com/gridcoin-community/Gridcoin-Research/releases). For more information, see https://gridcoin.us/.
8
8
9
9
Building Gridcoin
10
10
=================
11
11
12
-
These dependencies are required:
12
+
The easiest way to build Gridcoin is with the included build script, which automatically installs dependencies for a wide range of Linux distributions and macOS:
|`native`| Dynamic linking against system libraries (development, packaging) |
23
+
|`depends`| Static linking for portable release binaries |
24
+
|`win64`| Windows cross-compilation from Linux |
25
+
|`macos`| macOS build (from macOS host) |
29
26
30
-
For more detailed and platform-specific instructions, see [the doc folder.](doc/)
27
+
Run `./build_targets.sh --help` for all options, including Qt5/Qt6 selection, ccache, build type, and more.
28
+
29
+
For manual builds and platform-specific instructions, see [doc/build.md](doc/build.md).
31
30
32
31
Development process
33
32
===================
@@ -37,7 +36,7 @@ development branch when they think their feature or bug fix is ready.
37
36
38
37
The patch will be accepted if there is broad consensus that it is a
39
38
good thing. Developers should expect to rework and resubmit patches
40
-
if they don't match the project's coding conventions (see [coding.txt](doc/coding.txt))
39
+
if they don't match the project's coding conventions (see [developer-notes.md](doc/developer-notes.md))
41
40
or are controversial.
42
41
43
42
The master branch is regularly built and tested, but is not guaranteed
@@ -50,32 +49,38 @@ worked on by several people.
50
49
Branching strategy
51
50
==================
52
51
53
-
Gridcoin uses four branches to ensure stability without slowing down
54
-
the pace of the daily development activities - *development*, *staging*, *master*
55
-
and *hotfix*.
52
+
Gridcoin uses five branches to ensure stability without slowing down
53
+
the pace of the daily development activities - *development*, *testnet*,
54
+
*staging*, *master*and *hotfix*.
56
55
57
56
The *development* branch is used for day-to-day activities. It is the most
58
57
active branch and is where pull requests go by default. This branch may contain
59
58
code which is not yet stable or ready for production, so it should only be
60
59
executed on testnet to avoid disrupting fellow Gridcoiners.
61
60
62
-
When a decision has been made that the development branch should be moving
63
-
towards a final release it is merged to *staging* where no new development
64
-
takes place. This branch is purely to stabilize the code base and squash out
65
-
bugs rained down from development. This is Gridcoin's beta testing phase.
61
+
When development is ready for broader testing, it is merged to *testnet* where
62
+
tagged testnet pre-releases are published. This branch is used extensively for
63
+
integration testing of consensus changes, hard fork activation, and new features
64
+
on the Gridcoin test network before any production release.
65
+
66
+
When a testnet release has been validated and a decision has been made to move
67
+
towards a production release, it is merged to *staging* as a final review step
68
+
before release.
66
69
67
-
Once the staging branch is stable and runs smoothly, it is merged to *master*, a tag is created,
70
+
Once staging is confirmed ready, it is merged to *master*, a tag is created,
68
71
and a release is made available to the public.
69
72
70
73
When a bug is found in a production version and an update needs to be
71
74
released quickly, the changes go into a *hotfix* branch for testing before
72
75
being merged to *master* for release. This allows for production updates without having to merge straight to
73
76
master if the staging branch is busy.
74
77
78
+
The typical release path is: *development* → *testnet* → *staging* → *master*.
79
+
75
80
Community
76
81
=========
77
82
78
-
For general questions, please visit our Discord server at https://discord.gg/UMWUnMjN4x, or Libera Chat in #gridcoin-help. We also have a Slack channel at [teamgridcoin.slack.com](https://join.slack.com/t/teamgridcoin/shared_invite/zt-3s81akww-GHt~_KvtxfhxUgi3yW3~Bg).
83
+
For general questions, please visit our [Discord server](https://discord.gg/UMWUnMjN4x), [Matrix room](https://matrix.to/#/#gridcoin:matrix.org), or Libera Chat in #gridcoin-help.
0 commit comments