Skip to content
This repository was archived by the owner on Sep 9, 2020. It is now read-only.

Commit 43f3859

Browse files
committed
Update readme and put in copyright notice
Signed-off-by: Joe Beda <[email protected]>
1 parent 0032791 commit 43f3859

File tree

2 files changed

+17
-120
lines changed

2 files changed

+17
-120
lines changed

README.md

+4-120
Original file line numberDiff line numberDiff line change
@@ -1,132 +1,16 @@
1-
homebrew-ksonnet
2-
=================
3-
4-
Homebrew Tap for ksonnet
1+
# Homebrew Tap for ksonnet
52

63
## Installation
74

85
```
9-
brew install ksonnet/ksonnet/ks
6+
brew install ksonnet/tap/ks
107
```
118

12-
139
## Development
14-
Get the latest development version with the `--devel` flag. Use `--build-from-source` if you don't want a pre-built bottle. Alternatively you can use the `--successful` flag (cpp-ethereum only, see [important note below](#important-note-when-using---successful)) or any other [available options](#options).
15-
16-
### C++ client
17-
```
18-
brew reinstall cpp-ethereum --devel
19-
```
20-
21-
For the latest successful build on develop (last successful build from [cpt-obvious](https://build.ethdev.com/waterfall)):
22-
```
23-
brew reinstall cpp-ethereum --devel --successful
24-
```
25-
26-
#### Important note when using --successful
27-
28-
If you get an error looking like this:
29-
```
30-
==> Cloning https://github.com/ethereum/cpp-ethereum.git
31-
Updating /Library/Caches/Homebrew/ethereum--git
32-
fatal: reference is not a tree: <latest commit hash>
33-
Error: Failed to download resource "ethereum"
34-
Failure while executing: git checkout -q -f
35-
```
36-
37-
Either try `brew fetch cpp-ethereum --devel` or simply delete the cache with `rm -rf /Library/Caches/Homebrew/cpp-ethereum--git`
38-
39-
40-
### Go client
41-
```
42-
brew reinstall ethereum --devel
43-
```
44-
45-
46-
### Current branches
47-
48-
Go:
49-
* `--devel` is on develop branch
50-
* normal install is on master branch
51-
52-
C++:
53-
* `--devel` is on [develop](https://github.com/ethereum/cpp-ethereum/commits/develop)
54-
* normal install is on master branch
55-
10+
Get the latest development version with the `--HEAD` flag.
5611

5712
## Upgrading
5813

5914
```
6015
brew update && brew upgrade
61-
```
62-
63-
## Minor updates
64-
65-
### Go client
66-
```
67-
brew update && brew reinstall ethereum
68-
```
69-
70-
### C++ client
71-
```
72-
brew update && brew reinstall cpp-ethereum
73-
```
74-
75-
76-
## Versions
77-
List available versions with:
78-
```
79-
ls -l /usr/local/Cellar/ethereum
80-
ls -l /usr/local/Cellar/cpp-ethereum
81-
```
82-
83-
If you have other versions installed, you can switch with:
84-
```
85-
brew switch ethereum <version>
86-
```
87-
Or follow this [StackOverflow answer](http://stackoverflow.com/a/9832084/2639784)
88-
89-
These brews can be installed via the raw GitHub URLs, or by cloning this
90-
repository locally with `brew tap ethereum/ethereum`. You can also install binary
91-
bottles directly with `brew install <bottle_url>`, see [cpt-obvious](https://build.ethdev.com/waterfall)
92-
for previous builds.
93-
94-
95-
##Options
96-
97-
See `brew info ethereum` or `brew info cpp-ethereum` for all options. `--with-...` features are experimental patches.
98-
99-
#### cpp-ethereum options
100-
Option | desc.
101-
-----------------------|---------
102-
`--with-evmjit` | Build with LLVM and enable EVMJIT
103-
`--successful` | Last successful build using --devel only
104-
`--with-debug` | Pass -DCMAKE_BUILD_TYPE=Debug
105-
`--with-vmtrace` | Build with -DVMTRACE=1
106-
`--with-paranoia` | Build with -DPARANOID=1
107-
108-
**Note:** `--with-evmjit` requires LLVM to be installed with `brew install llvm --HEAD --with-clang`
109-
110-
##Troubleshooting
111-
112-
* Use `--verbose` to get more info while installing.
113-
* Make sure to update XCode and the command line tools.
114-
* Run `brew update` and `brew upgrade`
115-
* Fix what the `brew doctor` says.
116-
* Reinstall dependencies: `brew reinstall boost --c++11 --with-python`
117-
* Make changes to `/usr/local/Library/Taps/ethereum/homebrew-ethereum/ethereum.rb`
118-
* Reinstall with `brew reinstall ethereum.rb` (send a pull request!)
119-
* Take a walk
120-
121-
122-
##Patching
123-
124-
First `cd /Library/Caches/Homebrew/ethereum--git/` and make your changes. Then `git diff > shiny.patch`, copy/paste the content of your patch under `__END__` of `ethereum.rb` and replace the `def patches` block with:
125-
126-
```
127-
def patches
128-
DATA
129-
end
130-
```
131-
132-
If you want to submit your change, save your patch in a gist, add your `option 'shiny-option', 'Shiny description'` and the URL to your gist in the patches block and submit a pull request. Make sure to send a pull request to Ethereum also!
16+
```

ks.rb

+13
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
# Copyright 2017 The Ksonnet Authors
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
114
require 'formula'
215

316
class Ks < Formula

0 commit comments

Comments
 (0)