Skip to content

Commit f148a81

Browse files
committed
Updated README with build instructions
Added build instructions to the README Added installer script to README Updated support links
1 parent 8a1de0c commit f148a81

File tree

3 files changed

+35
-2
lines changed

3 files changed

+35
-2
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
![allocscope banner](https://allocscope.com/banner.png)
2+
13
# allocscope
24
### a memory tracking tool
35

@@ -13,6 +15,37 @@ allocation functions such as `malloc` it tracks allocations made by that process
1315
allocations made in a call tree format, which can be sorted by largest concurrent allocation,
1416
total number of blocks, or number of unfreed allocation blocks.
1517

18+
# Installing prebuilt binaries
19+
20+
The easiest way to get started with allocscope is to install prebuilt binaries.
21+
22+
To install the latest version:
23+
24+
`curl -s https://allocscope.com/install.sh | sudo sh`
25+
26+
Currently only Linux on x86_64 processors is supported, but I'd like to support more operating systems
27+
and processors in the future.
28+
29+
# Building from source
30+
31+
On recent Ubuntu releases, allocscope can be built from source with the following sequence
32+
of commands:
33+
34+
```
35+
apt-get update
36+
apt-get install cargo git libclang-dev libiberty-dev libncurses-dev libsqlite3-dev libunwind-dev
37+
git clone https://github.com/matt-kimball/allocscope.git
38+
cd allocscope
39+
cargo install --path allocscope-trace
40+
cargo install --path allocscope-view
41+
```
42+
43+
# Support development
44+
45+
If you find allocscope useful, please consider supporting development.
46+
47+
Visit https://allocscope.com/support
48+
1649
# License
1750

1851
allocscope is licensed GNU General Public License version 3.

allocscope-view/src/report.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ pub fn generate_report(trace: trace::Trace) -> Result<(), Box<dyn Error>> {
102102
rows::iter_stackentry_rows(&mut transaction, rows::SortMode::Bytes, None, 0, row_count)?;
103103

104104
println!("allocscope {} memory report", env!("CARGO_PKG_VERSION"));
105-
println!("https://support.mkimball.net/");
105+
println!("https://allocscope.com/support");
106106
println!("");
107107
println!("BYTES BLOCK LEAKS Function");
108108
for entry in rows {

allocscope-view/src/ui.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ impl UIState {
155155

156156
let width = self.screen.get_max_x();
157157
let mut support_link = format!(
158-
"https://support.mkimball.net/ {} ",
158+
"https://allocscope.com/support {} ",
159159
env!("CARGO_PKG_VERSION")
160160
);
161161
while (support_link.len() as i32) < width - self.screen.get_cur_x() {

0 commit comments

Comments
 (0)