Commit ccc9301c authored by Luc Didry's avatar Luc Didry
Browse files

Add a real README + install instructions

parent 01c0c043
Pipeline #24480 passed with stage
in 20 seconds
sudo apt-get install libcairo2-dev libjpeg-dev libpango1.0-dev libgif-dev build-essential
# WemaWema
![WemaWema logo](https://framagit.org/uploads/-/system/project/avatar/17831/Logo.png)
## What is it?
It's a "WE MAKE PORN" meme generator
## How to use it?
Go to an instance (official instance [here](https://luc.frama.io/wemawema)) and follow your heart.
## How to install it?
```
git clone https://framagit.org/luc/wemawema.git
```
and configure your web server to serve the `wemawema` directory
## What about the service?
WemaWema provides a service which generates an image, suitable for embedding, like this:
![WE MAKE IMAGES](https://wema.fiat-tux.fr/?p=IMAGES)
```
![WE MAKE IMAGES](https://wema.fiat-tux.fr/?p=IMAGES)
```
This service is able to answer to [Mattermost](https://mattermost.com) [slash commands](https://docs.mattermost.com/developer/slash-commands.html).
It answers the URL of an image containing the provided text, and Mattermost will make it viewable in the current channel.
### Service installation
Install the dependencies (for Debian):
```
sudo apt-get install libcairo2-dev libjpeg-dev libpango1.0-dev libgif-dev libpng-dev build-essential nodejs
```
Go to WemaWema service folder and install the packages:
```
cd wemawema/server
npm install
```
Copy the systemd service file, adapt it to your installation, enable and start it:
```
sudo cp wemawema.service /etc/systemd/system/
systemctl daemon-reload
systemctl enable wemawema.service
systemctl start wemawema.service
```
The service will listen on the unix socket `/tmp/wemawema.sock`
Add this to your nginx configuration, it should work well:
```
location / {
proxy_set_header Host $host;
proxy_pass http://unix:/tmp/wemawema.sock:;
proxy_set_header X-Forwarded-Proto $scheme;
}
```
## License
AGPLv3. See the [LICENSE](LICENSE) file for details
## Support the developer
You can support the developer on [Liberapay](https://liberapay.com/sky/) or [Tipeee](https://www.tipeee.com/fiat-tux).
## Logo
Logo "Fez Hat", by [GDJ](https://openclipart.org/user-detail/GDJ), public domain.
img/favicon.png

8.79 KB | W: | H:

img/favicon.png

6.55 KB | W: | H:

img/favicon.png
img/favicon.png
img/favicon.png
img/favicon.png
  • 2-up
  • Swipe
  • Onion skin
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
version="1.1"
id="Layer_1"
x="0px"
y="0px"
viewBox="0 0 1571.256 1724.137"
enable-background="new 0 0 1571.256 1724.137"
xml:space="preserve"
sodipodi:docname="Logo.svg"
inkscape:version="0.92.2 (5c3e80d, 2017-08-06)"
inkscape:export-filename="/home/luc/tmp/wemawema/img/Logo.png"
inkscape:export-xdpi="48"
inkscape:export-ydpi="48"><metadata
id="metadata23"><rdf:RDF><cc:Work
rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title></dc:title></cc:Work></rdf:RDF></metadata><defs
id="defs21" /><sodipodi:namedview
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1"
objecttolerance="10"
gridtolerance="10"
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1680"
inkscape:window-height="1020"
id="namedview19"
showgrid="false"
inkscape:zoom="0.44325619"
inkscape:cx="310.73332"
inkscape:cy="862.06848"
inkscape:window-x="0"
inkscape:window-y="30"
inkscape:window-maximized="0"
inkscape:current-layer="Layer_1" /><g
id="g16"><path
fill="#AA0000"
stroke="#AA0000"
stroke-width="0.5"
d="M664.28,67.279c487.361-42.811,849.632,187.271,553.519,356.87 c-23.605,13.416-52.678,26.224-59.944,28.389c-19.704-24.978-65.803-57.835-99.102-75.193 c-4.967-2.969-186.193-75.578-186.924-75.871c4.429-2.036,8.368-5.085,11.119-9.135l0.832-0.058 c-0.025-0.263-18.576-110.668-18.619-110.929c-2.221-28.268-104.504-32.205-107.821,2.057 c-1.339,8.778-14.795,95.361-15.832,100.612c-9.795,18.606,39.387,30.584,87.355,27.309 c54.717,40.742,137.666,67.901,308.804,149.028c-96.634,42.418-349.661,83.092-593.684,34.722 C75.077,400.964,155.675,113.025,664.28,67.279z"
id="path2" /><path
fill="#333333"
stroke="#333333"
stroke-width="0.5"
d="M776.325,164.229c14.577-5.1,30.315-6.092,45.622-4.969 c11.199,1.065,22.596,3.232,32.533,8.733c5.056,2.86,10.193,7.135,10.681,13.359c-0.985,7.223-7.573,11.593-13.607,14.526 c-12.432,5.72-26.302,7.464-39.865,7.639c-12.556-0.058-25.288-1.561-37.086-6.041c-6.982-2.758-14.14-6.866-17.262-14.067 c0.066-0.679,0.131-1.364,0.204-2.043c11.995-0.161,23.997,0.08,35.991-0.226c-11.987-0.102-23.967-0.175-35.955-0.131 c0.124-2.765,1.24-5.414,3.145-7.427C764.936,169.088,770.605,166.293,776.325,164.229z"
id="path4" /><path
stroke="#000000"
stroke-width="0.5"
d="M757.581,181.009c11.987-0.044,23.967,0.029,35.955,0.131 c-11.995,0.306-23.997,0.066-35.991,0.226L757.581,181.009z"
id="path6" /><path
stroke="#000000"
stroke-width="0.5"
d="M865.161,181.352c5.056,30.468,10.251,60.922,15.358,91.39 c0.861,6.552,2.641,12.95,3.261,19.539l-0.832,0.058c-47.431-0.715-94.87-1.109-142.302-1.868c0.277-2.152,0.584-4.297,0.861-6.45 c1.299-6.574,2.116-13.235,3.225-19.845c4.188-26.922,8.5-53.83,12.608-80.767c3.123,7.201,10.28,11.309,17.262,14.067 c11.798,4.48,24.529,5.983,37.086,6.041c13.563-0.175,27.433-1.919,39.865-7.639C857.588,192.946,864.176,188.575,865.161,181.352z "
id="path8" /><path
fill="#800000"
stroke="#800000"
stroke-width="0.5"
d="M1323.424,281.921c2.902,16.518-9.996-60.195,191.258,1135.822 c-0.992-0.029-1.963-0.044-2.911-0.029c3.672,31.578-12.126,57.936-33.963,80.701 c-203.951,204.86-1076.491,221.026-1353.426,27.915c-92.638-64.257-64.135-118.512-62.147-132.146 C242.777,242.494,231.397,314.784,233.567,302.08c2,7.368,3.471,26.779,22.997,53.801 c57.439,78.173,192.101,120.069,287.419,139.201c244.329,48.431,498.008,7.276,593.684-34.722c3.933,1.86,8.048,3.312,12.133,4.837 c-16.646,61.926-3.446,141.179,25.66,421.221c-34.406,23.757-28.518,40.032-29.25,48.803c-2.13,49.598-4.188,99.204-6.289,148.802 c-0.445,6.085,0,12.272-1.408,18.255c-0.956,4.582-0.379,9.733,2.663,13.461c11.281,14.418,43.18,11.647,61.359,8.193 c34.678-6.756,81.896-28.198,98.533-54.713c2.101-3.072,2.823-6.836,4.969-9.871c-0.041-1.344-26.995-135.952-33.467-168.421 c-0.912-4.808-1.802-9.944-5.107-13.768c-11.247-13.395-36.571-11.786-53.48-7.581c0.385-27.976-0.909-50.689-1.736-56.238 c-52.868-378.567-46.74-350.819-54.392-360.803c8.885-2.647,147.75-55.681,163.803-145.548 C1323.395,298.745,1323.095,290.289,1323.424,281.921z"
id="path10" /><path
fill="#333333"
stroke="#333333"
stroke-width="0.5"
d="M742.099,294.156c-2.408-2.853-2.262-6.96-0.591-10.134 c-0.277,2.152-0.584,4.297-0.861,6.45c47.431,0.759,94.87,1.153,142.302,1.868c-2.751,4.049-6.69,7.099-11.119,9.135 c-13.469,6.209-28.316,8.536-42.966,9.857c-22.333,1.525-45.162,0.533-66.729-5.859 C754.911,302.948,747.039,300.372,742.099,294.156z"
id="path12" /><path
stroke="#000000"
stroke-width="0.5"
d="M828.863,311.331c14.65-1.321,29.498-3.648,42.966-9.857 c56.267,22.574,112.461,45.323,168.706,67.933c6.143,2.459,12.505,4.524,18.218,7.938c24.004,12.513,46.461,27.871,67.576,44.776 c11.236,9.324,22.45,18.911,31.526,30.417c1.963,2.561,3.794,5.29,4.961,8.317c0.605,2.335,0.182,4.815,0.817,7.165 c1.328,5.093,2.072,10.317,2.933,15.511c15.271,109.929,30.329,219.887,45.68,329.809c0.97,6.508,0.722,13.118,1.306,19.67 c0.584,12.177,0.598,24.376,0.43,36.568c10.12-2.517,20.677-3.67,31.081-2.627c8.201,1.021,16.898,3.655,22.399,10.207 c3.305,3.823,4.195,8.96,5.107,13.768c10.309,51.721,20.626,103.436,30.964,155.15c1.335,4.319,2.364,8.719,2.503,13.271 c-2.145,3.035-2.867,6.8-4.969,9.871c-4.239,6.756-9.879,12.564-16.131,17.474c-9.923,8.31-21.18,14.855-32.759,20.575 c-15.84,7.398-32.453,13.315-49.642,16.664c-14.016,2.663-28.571,4.093-42.703,1.466c-6.88-1.445-14.169-3.925-18.656-9.66 c-3.042-3.728-3.619-8.879-2.663-13.461c1.408-5.983,0.963-12.17,1.408-18.255c2.101-49.598,4.159-99.204,6.289-148.802 c0.496-5.946-0.773-12.133,1.576-17.817c4.947-13.388,16.241-23.092,27.674-30.986c-9.156-88.099-18.393-176.199-27.579-264.298 c-1.364-15.088-3.757-30.089-4.465-45.235c-1.291-20.633-1.219-41.332-0.204-61.972c1.065-16.679,2.233-33.511,6.588-49.715 c-4.086-1.525-8.201-2.977-12.133-4.837c-20.239-9.594-40.748-18.605-61.104-27.944c-58.514-26.572-117.035-53.151-175.549-79.724 c-10.017-4.487-20.115-8.828-29.717-14.183C856.588,330.381,842.346,321.37,828.863,311.331z"
id="path14" /></g></svg>
\ No newline at end of file
......@@ -7,7 +7,7 @@
<link href="css/normalize.css" rel="stylesheet">
<link href="css/skeleton.css" rel="stylesheet">
<link href="css/wema_wema.css" rel="stylesheet">
<link href="img/favicon.png" rel="icon" type="image/png">
<link href="img/favicon.png?v=2" rel="icon" type="image/png">
</head>
<body>
<div class="container">
......
Supports Markdown
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