Skip to content

Commit 8a1151e

Browse files
committed
MOTD and documentation updates for 0.6.0
1 parent d313b7f commit 8a1151e

File tree

4 files changed

+66
-126
lines changed

4 files changed

+66
-126
lines changed

NEWS.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
News
22
====
3+
- **2017-04-23:** Release of BitWrk 0.6.0 (Mars) brings local network rendering and usability enhancements for Blender
4+
- **2017-04-17:** Release candidate 1 of BitWrk 0.6.0
5+
- **2017-04-05:** BitWrk got [featured in Bitcoin Magazine](https://bitcoinmagazine.com/articles/soon-youll-be-able-buy-and-sell-system-resources-p2p-bitcoin/)
6+
- **2015-11-01:** Release of BitWrk 0.5.1 "Moon": Support for Blender 2.76,
7+
compressed data transmission, revised transaction logic and lots of bugs fixed
8+
- **2015-08-10:** Release of BitWrk 0.5.0: Bitcoin integration is finally here, allowing
9+
users to pay in Bitcoin
10+
- **2015-01-15:** News have moved to BitWrk's website: http://bitwrk.net
11+
- **2014-12-30:** BitWrk was featured in a Lightning Talk by the lead developer on the
12+
31st Chaos Communication Congress: https://www.youtube.com/watch?v=BHBe5g5KKiw
13+
- **2014-12-05:** New participants now start with a zero balance as preparations for an upcoming
14+
beta test have started. The test will include real Bitcoin transactions processed by the
15+
payment system.
16+
- **2014-11-11:** Payment system integration is progressing. Required refactoring BitWrk into
17+
separate projects:
18+
319
- **2014-11-11:** Payment system integration is progressing. Required refactoring BitWrk into
420
separate projects:
521
- **bitwrk** now contains code specific to client and server and may be refactored further at

QUICKSTART.md

Lines changed: 23 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -7,49 +7,31 @@ systems for which binary packages are provided. Linux users can easily compile B
77
[themselves](COMPILING.md) and possibly resort to other shortcuts, such as installing
88
BitWrk or the Go development kit using the system's package manager.
99

10-
Running the BitWrk client
11-
-------------------------
12-
### Mac OS X
13-
- **Step 1:** Download the binary file from https://github.com/indyjo/bitwrk/releases into your *Downloads* folder
14-
15-
bitwrk-x.y.z-osx-x64.tar.gz
16-
- **Step 2:** Open a Terminal and type:
17-
18-
cd ~/Downloads/
19-
tar xzf bitwrk.x.y.z-osx-x64.tar.gz
20-
cd bitwrk-x.y.y/bin
21-
./bitwrk-client
22-
- **Step 3:** Open http://localhost:8081/ in your browser.
23-
24-
### Windows 7 or 8
25-
- **Step 1:** Download the binary file from https://github.com/indyjo/bitwrk/releases
26-
27-
bitwrk-x.y.z-windows.x64.zip
28-
- **Step 2:** Open the downloaded .zip file and drag the contained folder "bitwrk-x.y.z" on your desktop.
29-
- **Step 3:** In the extracted folder, double-click the file called "bitwrk-client.exe".
30-
It should open in a command shell window.
31-
- **Step 4:** Open http://localhost:8081/ in your browser.
32-
33-
### Done!
34-
Now you should see the BitWrk client's admin user interface on http://localhost:8081/,
35-
showing your account number (which has been randomly chosen) and your current
36-
balance of **BTC 0** in the status bar at the top of the page.
37-
38-
Your next step is to try buying and selling on the BitWrk network using Blender,
39-
BitWrk's first supported application.
40-
41-
For selling, you may skip a couple of paragraphs.
42-
For buying, i.e. rendering, you need to first deposit some money on your account.
43-
44-
Depositing money on your account
45-
--------------------------------
46-
Before you can start buying on BitWrk, you need to deposit a small amount of Bitcoin on your
47-
account, which will be used to pay for the computing power you use. Deposits can be as small
10+
Using BitWrk for rendering
11+
--------------------------
12+
[![5 Minute introduction to BitWrk](https://img.youtube.com/vi/KmwcxwhIRr0/0.jpg)](https://www.youtube.com/watch?v=KmwcxwhIRr0)
13+
14+
You need at least Blender 2.76 (Blender 2.78 is recommended).
15+
16+
Download the BitWrk binary release specific your OS and unpack it somewhere.
17+
18+
Download **render_bitwrk-0.6.0.zip** and install it as a Blender add-on (see [Blender Manual](https://docs.blender.org/manual/en/dev/preferences/addons.html)).
19+
20+
In the settings of the Blender add-on there is an option to select which BitWrk client you would like to start. Select the executable from the archive you downloaded (bitwrk-client.exe or just bitwrk-client). Click on "Start BitWrk client".
21+
22+
### Rendering for free
23+
To start a render, press F12 as usual. You will see that a number of colored tiles is shown in the render area. Before rendering can begin, you need to set the price you're willing to pay for a tile. You can do that in the BitWrk client's user interface. Click on "Open BitWrk Client User Interface". Click on "Publish". Set **"BTC 0"** as price. Set "Valid up to" to 100 trades. Click "Submit" and BitWrk will start dispatching tiles to the network, accelerating your rendering.
24+
25+
You can accelerate it further by starting a worker on your own computer.
26+
27+
### Depositing money on your account
28+
In the long term, rendering won't always be free. In order to pay for the computing power you
29+
use, you need to deposit a small amount of Bitcoin on your aacount. Deposits can be as small
4830
as 1 mBTC (BTC 0.001), i.e. you *don't* need to put large amounts of money on BitWrk, and
4931
there is *no* subscription involved.
5032

5133
To deposit money on your account:
52-
- Make sure you have a Bitcoin client installed (either on you PC, or on your cell phone, tablet
34+
- Make sure you have a Bitcoin client installed (either on your PC, or on your cell phone, tablet
5335
etc.) that has some money on it. Please refer to http://bitcoin.org for more information on that
5436
topic.
5537
- In the BitWrk client's user interface, go to the "Accounts" tab (http://localhost:8081/ui/account)
@@ -61,37 +43,8 @@ To deposit money on your account:
6143
about one hour, which equates to 6 Bitcoin confirmations.
6244

6345

64-
Blender Integration
65-
-------------------
66-
Starting with the 20140124 release, BitWrk supports the popular 3D rendering
67-
software, Blender (http://blender.org/), as a proof-of-concept project.
68-
69-
70-
### Accelerating Blender with BitWrk
71-
In order to use BitWrk to accelerate Blender's "Cycles" rendering engine, perform
72-
the following steps:
73-
- Setup the BitWrk client as described in the previous section.
74-
- Start Blender (if in doubt, use the version supported by the latest BitWrk release).
75-
- Select a scene you like. Verify that it looks
76-
good when rendered with the "Cycles" rendering engine.
77-
- Go to **User Preferences -> Addons -> Install From File**
78-
- Select **render_bitwrk.py**. You find it in BitWrk's **bitwrk-blender** folder.
79-
- An add-on called "Render: BitWrk Distributed Rendering" should show up. If not,
80-
search for the new add-on by entering "bitwrk" in the add-on search field.
81-
- Activate the add-on by pressing the checkbox next to the running man icon.
82-
- Click "Save User Settings" to have the BitWrk add-on load every time you start Blender.
83-
- Back in the main window, you can now select "BitWrk distributed rendering" as the
84-
active rendering engine.
85-
- You should see a new panel, "BitWrk distributed rendering". Everything can be left as is
86-
for now. There should be a button labeled "Open BitWrk Client User Interface".
87-
- Next time you hit render (F12), the task is dispatched to the BitWrk service as several
88-
small tiles.
89-
- You now need to browse to the BitWrk client's user interface (on http://localhost:8081/)
90-
permit the buys you just made. You can choose a price you are willing to pay for each
91-
tile. The minimum price allowed by BitWrk is 10 uBTC (BTC 0.00001).
92-
93-
94-
### Selling rendering power on BitWrk
46+
Selling rendering power on BitWrk
47+
---------------------------------
9548
This is a little bit more involved and requires some knowledge abort networking and using
9649
the command line.
9750

README.md

Lines changed: 24 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,31 @@
1-
BitWrk - A Bitcoin-friendly, anonymous marketplace for computing power
2-
======================================================================
1+
BitWrk - Bitcoin-fueled Peer-to-Peer Rendering (and more)
2+
=========================================================
33

4-
BitWrk introduces a new kind of _cloud computing_, in which resources are shared in a peer-to-peer
5-
fashion.
4+
[![5 Minute introduction to BitWrk](https://img.youtube.com/vi/KmwcxwhIRr0/0.jpg)](https://www.youtube.com/watch?v=KmwcxwhIRr0)
65

7-
This is interesting for two groups of people:
8-
- The **buyers**: Users who require lots of computing power at their finger tips.
9-
For example, artists using rendering software such as [Blender](http://blender.org)
10-
to create impressive movies.
11-
- The **sellers**: Hardware owners who have computing power to spare and would like to
12-
monetize that resource in times of low workload.
13-
14-
BitWrk provides a service to both groups by connecting them in an easy-to-use way.
6+
Artists use [Blender](http://blender.org), a powerful yet free 3D software, to create impressive
7+
pictures and movies. This a requires a time-consuming, and costly, production step called _rendering_.
158

16-
Users of BitWrk can even be a buyer and a seller at the same time, enabling them to compensate for
17-
bursts of high need for computing power by continuously providing some computing power to others, at
18-
virtually no cost.
9+
BitWrk integrates with Blender and makes rendering much quicker by dispatching it to a swarm of
10+
computers.
1911

20-
> Keep in touch with this project and be informed about news and updates:<br>
21-
> **Website:** https://bitwrk.net/
22-
> **Facebook:** https://www.facebook.com/bitwrk
23-
> **Twitter:** https://twitter.com/BitWrk
12+
By creating a _marketplace for computing power_, BitWrk introduces a new kind of
13+
_cloud computing_, in which resources are shared in a peer-to-peer fashion. It
14+
works like a stock exchange, using crypto currency [Bitcoin](https://bitcoin.org/)
15+
for payment.
2416

25-
master: [![Build Status](https://travis-ci.org/indyjo/bitwrk.svg?branch=master)](https://travis-ci.org/indyjo/bitwrk)
26-
experimental: [![Build Status](https://travis-ci.org/indyjo/bitwrk.svg?branch=experimental)](https://travis-ci.org/indyjo/bitwrk)
17+
This is interesting for two groups of people:
18+
- The **buyers**: Users who require lots of computing power at their finger tips.
19+
- The **sellers**: Hardware owners who have computing power to spare and would like to
20+
monetize that resource.
2721

28-
What next?
29-
----------
30-
- Visit BitWrk's website at http://bitwrk.net
31-
- For the impatient: Following the [Quick Start Instructions](QUICKSTART.md) gets you
32-
started in 5 minutes.
33-
- [About BitWrk](ABOUT.md) explains what BitWrk is and what it is meant to become.
34-
- [Compiling BitWrk Yourself](COMPILING.md) caters to developers and Linux users.
35-
- Read more about the [Concepts Behind BitWrk](CONCEPTS.md).
36-
- Consult [this file](COPYING) about the license under which BitWrk is distributed (GPLV3).
22+
BitWrk provides a service to both groups by connecting them in an easy-to-use way.
3723

24+
### On the web
25+
[bitwrk.net](https://bitwrk.net/) | [Download](https://github.com/indyjo/bitwrk/releases) | [Facebook](https://www.facebook.com/bitwrk) | [Twitter](https://twitter.com/BitWrk)
3826

39-
News
40-
----
41-
- **2017-04-17:** Release candidate 1 of BitWrk 0.6.0 brings local network rendering and usability enhancements to Blender
42-
- **2017-04-05:** BitWrk got [featured in Bitcoin Magazine](https://bitcoinmagazine.com/articles/soon-youll-be-able-buy-and-sell-system-resources-p2p-bitcoin/)
43-
- **2015-11-01:** Release of BitWrk 0.5.1 "Moon": Support for Blender 2.76,
44-
compressed data transmission, revised transaction logic and lots of bugs fixed
45-
- **2015-08-10:** Release of BitWrk 0.5.0: Bitcoin integration is finally here, allowing
46-
users to pay in Bitcoin
47-
- **2015-01-15:** News have moved to BitWrk's website: http://bitwrk.net
48-
- **2014-12-30:** BitWrk was featured in a Lightning Talk by the lead developer on the
49-
31st Chaos Communication Congress: https://www.youtube.com/watch?v=BHBe5g5KKiw
50-
- **2014-12-05:** New participants now start with a zero balance as preparations for an upcoming
51-
beta test have started. The test will include real Bitcoin transactions processed by the
52-
payment system.
53-
- **2014-11-11:** Payment system integration is progressing. Required refactoring BitWrk into
54-
separate projects:
55-
- **bitwrk** now contains code specific to client and server and may be refactored further at
56-
a later time.
57-
- **bitwrk-common** contains code that is shared amongst client, server, and payment processor.
58-
- **cafs**, the Content-Addressable File System, has been extracted for use in third-party projects.
59-
- [More news...](NEWS.md)
27+
### Documentation
28+
[News](NEWS.md) | [Quickstart instructions](QUICKSTART.md) | [Concepts](CONCEPTS.md) | [Compiling](COMPILING.md) | [License information](COPYING)
6029

6130
Status
6231
------
@@ -90,3 +59,7 @@ As of version 0.6.0:
9059
local programs and dispatching them to the BitWrk service. For sellers, it
9160
provides the service to offer local worker programs to the BitWrk
9261
exchange and to keep them busy.
62+
63+
### Build status
64+
master: [![Build Status](https://travis-ci.org/indyjo/bitwrk.svg?branch=master)](https://travis-ci.org/indyjo/bitwrk)
65+
| experimental: [![Build Status](https://travis-ci.org/indyjo/bitwrk.svg?branch=experimental)](https://travis-ci.org/indyjo/bitwrk)

bitwrk-server/src/github.com/indyjo/bitwrk-server/server_motd.go

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,14 @@ func getMessageOfTheDay(r *http.Request) motd {
5454
minor, _ := strconv.ParseInt(matches[2], 10, 16)
5555
micro, _ := strconv.ParseInt(matches[3], 10, 16)
5656

57-
if major == 0 && minor == 6 && micro == 0 {
58-
return motd{"Thanks for supporting BitWrk by trying out Version 0.6.0!", false}
59-
} else if major > 0 || major == 0 && (minor > 5 || minor == 5 && micro >= 1) {
57+
if major > 0 || major == 0 && (minor > 6 || minor == 6 && micro >= 0) {
6058
return motd{fmt.Sprintf("Welcome to the BitWrk network!"+
6159
" Your client is up to date (version %d.%d.%d).", major, minor, micro), false}
6260
} else {
63-
return motd{fmt.Sprintf("BitWrk proudly announces version 0.5.1!"+
61+
return motd{fmt.Sprintf("BitWrk proudly announces version 0.6.0!"+
6462
" You are currently running client version %d.%d.%d."+
6563
" For information on what's new and how to upgrade please visit"+
66-
" <a target=\"_blank\" href=\"http://bitwrk.net/\">bitwrk.net</a>.",
64+
" <a target=\"_blank\" href=\"https://bitwrk.net/\">bitwrk.net</a>.",
6765
major, minor, micro), true}
6866
}
6967
}

0 commit comments

Comments
 (0)