Commit 1574edb6 authored by Michelle Fink's avatar Michelle Fink
Browse files

Merge branch 'readme_fixes' into 'master'

Readme fixes

See merge request Librem-5-Case-Creating-Community/librem-5-model!10
parents 842880e5 bd9d979a
#!/usr/bin/make -f
.SUFFIXES: .scad .stl .png .gif
.PHONY: all clean run dbg
.PHONY: all png stl clean
OSFLAGS=--imgsize 1440,720 --colorscheme Solarized
OSFLAGS=--imgsize 1440,720 --colorscheme Solarized --viewall --autocenter
.scad.stl:
openscad -o $@ $<
......@@ -10,21 +10,20 @@ OSFLAGS=--imgsize 1440,720 --colorscheme Solarized
.scad.png:
openscad --camera -200,200,140,0,0,0 $(OSFLAGS) -o $@ $<
PNG=$(foreach x, $(wildcard scad_files/*.scad), $(subst .scad,.png, $(x)))
STL=$(foreach x, $(wildcard scad_files/*.scad), $(subst .scad,.stl, $(x)))
PNG=$(foreach x, $(wildcard */*.scad), $(subst .scad,.png, $(x)))
STL=$(foreach x, $(wildcard */*.scad), $(subst .scad,.stl, $(x)))
all: $(PNG)
cp scad_files/*.png .
all: png stl librem5_model/librem5_model.gif
run: $(STL)
png: $(PNG)
dbg:
stl: $(STL)
librem5_model.gif: scad_files/librem5_model.scad
openscad --animate=60 -D '$$vpd=800' -D '$$vpr=[0,$$t*360,0]' -D '$$vpt=[0,100,0]' --viewall --autocenter --imgsize 600,800 --colorscheme Solarized $<
librem5_model/librem5_model.gif: librem5_model/librem5_model.scad
openscad --animate=60 -D '$$vpd=800' -D '$$vpr=[0,$$t*360,0]' -D '$$vpt=[0,100,0]' --imgsize 600,800 --colorscheme Solarized $<
convert frame*.png $@
rm frame*.png
clean:
rm -f scad_files/*.png
rm -f */*.png */*.gif
**Notice: Everything in this repository is UNOFFICIAL.**
**Notice: Everything in this repository is UNOFFICIAL.**
**Notice: The L5CCC is not affiliated in any way with Purism.**
# Librem 5 OpenSCAD
***Please Note:*** These models are *untested* by the authors, and may not be printable by consumer-grade fused-filament 3D printers.
# Introduction
This repository is a part of the Librem 5 Case Creating Community. It is a collection of 3-D models of both the phone itself and possible cases, external protective bump cases, or alternatives to the case that the phone will ship with. The purpose of modeling the appearance of the phone itself is so it can then be used as a basis for modeling custom cases.
The software used to make these models is OpenSCAD (https://www.openscad.org/) - a free and cross-platform 3-D modeling software that is command-based (rather than drawing/artistic). This makes the program relatively easy for coders to learn, and also easy to share the source code for modification.
The rendered 3-D models (STL format) can be imported into other 3-D design software, or given to a third-party to print it for you. You are welcome to modify these designs or contribute your own.
# Contents
## `librem5_model/`
Phone (Evergreen) 3-D model by @mick, based on [PhoneOutline.scad](https://source.puri.sm/Librem5/3D_designs/-/blob/master/Librem5-Case/PhoneOutline.scad).
<img height="300px" src="librem5_model/librem5_model.gif"><br/>
## `example_bump_case/`
Bump cases using the `librem5_model` above by @mick.
<img height="300px" src="example_bump_case/example_bump_case.png"><br/>
## `Librem5cover/`
A bump case by @eric.spivey
<img height="300px" src="Librem5cover/Librem5cover.png"><br/>
## `silicone_bump_case/`
Bump cases using the above model by @mick.
<img height="300px" src="silicone_bump_case/silicone_bump_case.png"><br/>
## Resources
# Building
Matrix: #Librem-5-Case-Creating-Community:matrix.org (https://matrix.to/#/#Librem-5-Case-Creating-Community:matrix.org)
The Images from the scad files are generated from the source by the Makefile. Just run
GitLab: https://source.puri.sm/Librem-5-Case-Creating-Community
```
$ make png
```
## Introduction
to regenerate all Images once the scad file(s) was changed. Although the files are generated they are added to the repo to provide a nice Readme.
This repository is a part of the Librem 5 Case Creating Community. It is a collection of 3-D models of both the phone itself and possible cases, external protective bump cases, or alternatives to the case that the phone will ship with. The purpose of modeling the appearance of the phone itself is so it can then be used as a basis for modeling custom cases.
If you require the [STL](https://en.wikipedia.org/wiki/STL_(file_format)) files just run
The software used to make these models is OpenSCAD (https://www.openscad.org/) - a free and cross-platform 3-D modeling software that is command-based (rather than drawing/artistic). This makes the program relatively easy for coders to learn, and also easy to share the source code for modification.
```
$ make stl
```
The rendered 3-D models (STL format) can be imported into other 3-D design software, or given to a third-party to print it for you. You are welcome to modify these designs or contribute your own.
If you run `make` without any parameters all images, stl and animation are generated at once.
## License
This repository contains free software and documentation. The 'default' license for this repository is the GNU General Public License Version 3 (GPLv3). The full text of the license is in the **LICENSE_GPL3** file included in this repository. Each contributor is free to license their files as they choose, as long as that license is for free software (or hardware) and compatible with GPL3. For a list of compatible licenses, see https://www.gnu.org/licenses/license-list.html. Please provide a copy of or link to your chosen license and explicitly name the license in the content of your work.
# Resources
## Contents
Matrix: [#Librem-5-Case-Creating-Community:matrix.org](https://matrix.to/#/#Librem-5-Case-Creating-Community:matrix.org)
+ **/scad_files/** Contains OpenSCAD source files
- **Librem5cover.scad** A bump case by @eric.spivey
- **librem5_model.scad** Phone (Evergreen) 3-D model by @mick, based on [PhoneOutline.scad](https://source.puri.sm/Librem5/3D_designs/-/blob/master/Librem5-Case/PhoneOutline.scad).
- **example_bump_case.scad** & **silicone_bump_case.scad** bump cases using the above model by @mick.
GitLab: [Librem-5-Case-Creating-Community](https://source.puri.sm/Librem-5-Case-Creating-Community)
# License
This repository contains free software and documentation. The 'default' license for this repository is the GNU General Public License Version 3 (GPLv3). The full text of the license is in the **LICENSE_GPL3** file included in this repository. Each contributor is free to license their files as they choose, as long as that license is for free software (or hardware) and compatible with GPL3. For a list of compatible licenses, see https://www.gnu.org/licenses/license-list.html. Please provide a copy of or link to your chosen license and explicitly name the license in the content of your work.
+ **/stl_files/** Contains the high-resolution 3-D models in [STL](https://en.wikipedia.org/wiki/STL_(file_format)) format. ***Please Note:*** These models are *untested* by the authors, and may not be printable by consumer-grade fused-filament 3D printers.
+ **librem5_model.gif** The animated GIF that you see above, from librem5_model.scad
+ **\*.png** Static images of the .scad files with the same name.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment